borderPattern

Type

property

Summary

Specifies the pattern of an object's border.

Syntax

set the borderPattern of <object> to {empty | <patternNumber> | <imageID>}

Description

Use the borderPattern property to specify the border pattern of a button or scrollbar.

Pattern images can be color or black-and-white.

Cross-platform note

To be used as a pattern on Mac OS systems, an image must be 128x128 pixels or less, and both its height and width must be a power of 2. To be used on Windows and Unix systems, height and width must be divisible by 8. To be used as a fully cross-platform pattern, both an image's dimensions should be one of 8, 16, 32, 64, or 128.

The borderPattern of controls is drawn starting at the control's upper right corner: if the control is moved, the pattern does not shift.

Setting the borderPattern of an object to empty allows the borderPattern of the object's owner to show through. Use the effective keyword to find out what color is used for the object, even if its own borderPattern is empty.

If the object's showBorder property is false, the borderPattern has no effect.

The setting of the borderPattern property has different effects, depending on the object type:

• The borderPattern of a stack, card, or group determines the borderPattern of each object in the stack, card, or group that does not have its own borderPattern.

• The borderPattern of a button determines the pattern of the border around the button. If the button's style is checkbox or radioButton, the borderPattern has no effect. If the button is a button menu, the borderPattern has no effect unless the button's menuMode property is set to comboBox or popup. If the button's threeD property is set to true, the borderPattern has no effect regardless of the button's style.

• The borderPattern of a field has no effect, except for the border around a scrolling field's scrollbar. The field's borderPattern also determines the pattern of the outline around any text in the field whose textStyle is set to "box".

• The borderPattern of a scrollbar determines the pattern of the border surrounding the scrollbar.

• The borderPattern of a graphic, audio clip, video clip, or image has no effect.

• The borderPattern of a player or EPS object determines the pattern of the border around the object. If the object's threeD property is set to true, the borderPattern has no effect.

If an object's borderPattern is set, the pattern is shown instead of the color specified by borderColor.

Examples

set the borderPattern of group "Nav" to myPattern

Related

object: button, EPS, field, stack

property: borderColor, borderWidth, foregroundPattern, height, markerFilled, menuMode, owner, patterns, pixels, shadowPattern, style, textStyle, threeD, width

command: group

function: stacks

glossary: audio clip, button menu, control, current stack, keyword, Mac OS, object, object type, property, Unix, video clip, Windows

keyword: button, card, control, effective, field, graphic, image, player, scrollbar

Compatibility and Support

Introduced

LiveCode 1.0

OS

mac

windows

linux

ios

android

Platforms

desktop

server

mobile